Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEAT: Docs upgrades throughout 📈 #1420

Merged
merged 1 commit into from
Feb 7, 2024

Conversation

daquinteroflex
Copy link
Collaborator

@daquinteroflex daquinteroflex commented Jan 29, 2024

Includes:

  • Better landing page initial
  • Better installation instruction page
  • Tabbed instructions for multiple platforms with emojis
  • Fixes a function wrapping docs issue Lucas raised

@daquinteroflex daquinteroflex marked this pull request as ready for review February 6, 2024 11:18
Copy link
Collaborator

@tylerflex tylerflex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @daquinteroflex I think this really improves things. Just a few minor comments.

docs/changelog.rst Outdated Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
@tylerflex
Copy link
Collaborator

one thing I fogot to mention: I think it's nice that we have some explanation of how to get to 2.6 if the link is broken. But is there a way to insert this information into a custom 404 page? (page not found. If you were trying to switch from an older version to 2.6, the link may have changed, please navigate from the main page).

@daquinteroflex
Copy link
Collaborator Author

Yep so the 404 is in my list in the #1148 but will get to that in another PR

@daquinteroflex
Copy link
Collaborator Author

Will be probably ready to merge when these changes build btw (should be as just updating submodule) @tylerflex , the next set of docs upgrades will come in the next PR including the 404 if that sounds good

@tylerflex tylerflex self-requested a review February 6, 2024 19:27
Copy link
Collaborator

@tylerflex tylerflex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok sounds good to me, feel free to merge whenever the build looks good.

@daquinteroflex daquinteroflex merged commit 398350f into pre/2.6 Feb 7, 2024
17 checks passed
@daquinteroflex daquinteroflex deleted the dario/docs_upgrades_throughout branch February 7, 2024 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants